4D Analytics

Map

Last updated: July 10, 2020

Widget sizes: 1 x 1, 2 x 2, 3 x 2, 4 x 2, 4 x 4

The Map widget allows the locations of sites to be viewed on a map, utilizing Bing Maps.

It can be populated with alarm status’ for individual sites, or display information in the form of gauges.

When you hover over a pin on the map, a popup is displayed (see image, above).

Map coordinates (Lat and Lon attributes) can be entered against a site via the Attributes function in Digital Twin Explorer. To display a container/site as a pint on the map widget, the container’s Lat and Lon coordinates need to be added, and the attribute MAP set to True.

Parameter Description
MAP This needs to be set to True, to display the container/site as a pin on the map.
LAT Set to the latitude of the container/site to be displayed on the map.
LON Set to the longitude of the container/site to be displayed on the map.
MAP_PIN_NAME_OVERRIDE An optional attribute. Setting this will override the name of the container/site pin on the map. If this Attribute is not on the container, or the Attribute Value is blank, then the default (container) name will be used as the label.

This will display the site (container) as a pin on the map.

The default Lat, Lon, and zoom level for the map are configured (per Organisation) via the Web Config “Map” section:

Web Config Element Name Description
Map default Latitude The default Latitude when the map widget loads.
Map default Longitude The default Longitude when the map widget loads.
Map default style Not applicable to Map widget.
Map default zoom The default zoom level used when the map widget loads. 1 is the lowest zoom (whole world view).
Map default zoom on single site An optional default zoom level to use when a site is selected from the dashboard treeview. So, the map could be at a lower level zoom, until a site is selected at which point the map zooms to a higher level.

The default Lat/Lon for an individual Map widget can be set within the widget config settings “Starting Latitude”, “Starting Longitude” (see “Customisation” section below). This will override the Web Config settings for the Organisation, but only for the individual Map widget. Additionally, as you click through the Dashboard treeview, the selected sites own Lat/Lon configurations will change the area displayed on the map.

Any points under the site(container) that need to be displayed on the popup as a gauge need to have the following attributes assigned:

Parameter Description
MAP This needs to be set to True, to display the point as a gauge. Anything else will suppress display.
METER_ROWNAME Label at base of dial.
METER_COLNAME Label at top of dial.
METER_INDEX Integer specifying order of gauges if more than a single gauge appears in the pop-up. For example: 1 (the dial to the left would be 0)

If alarms are configured on points, then (if displayed) their parent container pin changes colour from the default green to match the alarm state, and (if enabled) the individual point(s) gauge dial is colour coded as per the alarm configuration.

All enabled alarms are displayed on the gauge dial as the colours below:

  • LOW FAULT – Red
  • LOW ALERT – Yellow
  • OK – Green
  • HIGH ALERT – Yellow
  • HIGH ALARM – Orange
  • HIGH FAULT – Red

If more than one point under a site is configured to display on the map, then the parent container pin colour will match the most severe alarm state of its child points. The gauge pointer points to the colour of current alarm state of the point.

Clicking on a gauge will take the user to an Engineering Chart of the single gauge point.

Clicking on the "Charts" link will take the user to an Engineering Chart of all the points configured as gauges for the site.

Note: Only the points that are configured to be displayed as gauges, will appear in the Engineering Chart.

An additional layer can be enabled on the Map widget to display lines, pins or polynomials. These layers can be linked to containers from the treeview by naming the files with the ident of the container the line/pin/polynomial is linked to. A container can have more than one line/pin/polynomial assigned to it. So whereas there can only be a single instance per container of a pin which appears because of a Lat/Lon attribute, there can be multiple instances of pins which appear because of the <site ident>_pins.xml files. Multiple pins could be used for example to link a series of electricity pylons to a single container for display purposes on the map.

Upload various <site ident>_poly.xml and <site ident>_lines.xml and <site ident>_pins.xml to the website, via the Administration “File Manager” page, into the “Map Data Folder”.

Customisation

Name Default Comment
Widget Heading Map Custom header to display or leave as default "Map".
Show Layer 1 FALSE True or False to show the layers generated by the uploaded XML files.
Start Zoom 8 The default zoom level used when the map widget loads. 1 is the lowest zoom (whole world view).
Note: A value entered here will override the value entered in the Web Config "Map default zoom", but only for this individual Map widget. Web Config "Map default zoom" covers the whole organisation's Map widgets.
Map Green Icon images/green.gif Select the image to represent the OK alarm status.
Map Yellow Icon images/yellow.gif Select the image to represent the High/Low Alert alarm status.
Map Orange Icon images/orange.gif Select the image to represent the High Alarm alarm status.
Map Red Icon images/red.gif Select the image to represent the High/Low Fault alarm status.
Show All Sites This Site With "This Site" set, only the pins and layers for the selected site and below are displayed on the map. With "All Sites" set, all pins and layers for all sites are displayed, regardless of which site is selected in the TreeView.
Note: When a site is selected from the TreeView, the map centres on its pin, overriding the "Starting Latitude" / "Starting Longitude" configuration (if set - see below), and also overriding the "Map default Latitude" / "Map default Longitude" set in Web Config (if configured).
Drilldown dashboard.jsp?1=1 Drilldown when a user clicks the drilldown link. Defaults to showing the first dashboard in the list. Example URL: dashboard.jsp?SelectionType=SINGLE&DashID=xxx replacing xxx with the ID of the dashboard to drilldown to.
Refresh Period No widget refresh Select a refresh period from the drop-down menu from between 15 seconds to 1 hour, or no refresh at all
Show Bing Dashboard TRUE True or False to show the map navigation controls.
Show Pin Pop-ups TRUE True or False to show pin pop-up information, which includes the gauges (if configured).
Show Site Name Label against Pin FALSE When set to True, pins display their container name (site name), under/over or to the side of the pin. Bing maps controls exactly where the label is displayed, depending upon overlap with other pin labels. Custom Pins (displayed only when "Show Layer 1"=True) are assigned labels of "Custom Pin " + their pin increment number. e.g. "Custom Pin 1", "Custom Pin 2", ... etc.
Starting Latitude The Starting Latitude for the individual Map Widget. Overrides the "Map default Latitude", if configured in Web Config.
Starting Longitude The Starting Longitude for the individual Map Widget. Overrides the "Map default Longitude", if configured in Web Config.
Map Style Road Choose between the following options to be the default style for the map. This can be overridden by the Bing Dashboard controls on the live map, but on refresh will revert to this default. Road - Default road map view. Aerial - Satellite view. Grayscale, Canvas Dark, Canvas Light - Different shades of road map. Darker shades of map background highlight lighter coloured pins.

Ordnance Survey - The map displays Ordnance Survey imagery. Ordnance Survey imagery is only available in the UK.

Do Clustering No Set the value to Yes to use clustering. Clustering takes closely positioned pins and groups them into clusters, making the map easier to navigate. As you zoom into the map, the clusters will break apart into their individual pins. The level at which this occurs is dependent upon the "Cluster Grid Size" setting - see below.
Cluster Grid Size 45 Clustering works by splitting the map into a grid. If two or more pins are in the same grid cell, then they are clustered together. Changing the "Cluster Grid Size" value, changes the size of the grid cells, and therefore changes the level at which pins are clustered. The smaller the value, the denser the clusters are. For example: A value of 100 will cluster a lot more pins (take in a wider range) than a value of 1.

Properties

There are no properties required for this widget.